Improve basic usage#382
Improve basic usage#382FireChickenProductivity wants to merge 43 commits intoTalonCommunity:mainfrom
Conversation
✅ Deploy Preview for talon-wiki-refactor ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
Co-authored-by: Nicholas Riley <com-github@sabi.net>
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
plik |
This is now ready for your review. |
chdoc
left a comment
chdoc
left a comment
There was a problem hiding this comment.
Altogether, I think the text looks pretty good. My comments mainly concern the section structure and logical grouping of commands.
| | `kebab` | dashes instead of spaces | | ||
| | `help formatters` | show all available formatters | | ||
|
|
||
| `help formatters` shows 2 types of formatters: prose formatters and code formatters. Code formatters are primarily for formatting identifiers and values in computer code. Prose formatters are primarily for ordinary text and are shown with a \* after them. When dictating text with a prose formatter, you can say the following in the middle of dictation. |
There was a problem hiding this comment.
I would (also) mention behavioral differences between prose and text formatters. Usage alone says nothing really.
There was a problem hiding this comment.
What behavioral differences did I leave out?
There was a problem hiding this comment.
Punctuation :) if you can provide a quick note that it supports lots of post formatting things and we can add a link to a specific description of the prose capture in a different PR.
|
|
||
| Function keys, like <kbd>f1</kbd>, can be dictated by saying `f` and then the key number. | ||
|
|
||
| ### Dictation Mode Editing and Navigation |
There was a problem hiding this comment.
Why is this a subsection of "pressing keys"? Shouldnt it be in its own "editing commands" section?
There was a problem hiding this comment.
Because these commands press keys. I wanted few high level sections to make it easier to find information.
|
|
||
| ### Command Mode Editing and Navigation | ||
|
|
||
| #### Edit/Navigation Actions and Modifiers |
There was a problem hiding this comment.
| #### Edit/Navigation Actions and Modifiers |
I'm not a fan of two successive headlines, nor am I a fan of fourth-level headlines.
| | `command mode` | Switch to command mode. | | ||
|
|
||
| ## Help Commands | ||
|
|
There was a problem hiding this comment.
This section should probably explain which of these commands work only in command mode and which work also indication mode.
| @@ -33,7 +33,9 @@ | |||
|
|
|||
There was a problem hiding this comment.
To me, pressing keys is the most basic functionality, I would explain that first before venturing on into dictation.
| | `undo that` | undo | | ||
| | `redo that` | redo | | ||
|
|
||
| #### Working With Tabs |
There was a problem hiding this comment.
This section definitely does not belong below "Command Mode Editing and Navigation"
There was a problem hiding this comment.
Working with tabs is a form of navigation.
| ## Customize Talon | ||
|
|
||
| These commands will open up a CSV or [Talon list](Customization/talon_lists.md) file in your default text editor that you can edit to customize voice commands without needing to write Talon scripts. | ||
|
|
||
| | Command | Description | | ||
| | ---------------------------- | ------------------------------------------------- | | ||
| | `customize additional words` | add additional words that Talon will recognize | | ||
| | `customize words to replace` | remap or reformat words that Talon will recognize | | ||
| | `customize alphabet` | change the default Talon alphabet | | ||
| | `customize websites` | add websites that can be opened with Talon | |
There was a problem hiding this comment.
I would put the customization at the very end. Also customize websites doesn't mean much without
explaining the go to <website> command.
There was a problem hiding this comment.
Some of this is preexisting stuff I was not going to change in the first PR. I do agree that go to <website> is worth explaining.
| | `focus "app name"` | say "focus chrome" for example, to switch active window to chrome | | ||
| | `running list` | see all active applications | | ||
| | `launch "app name"` | say "launch chrome" for example, to open chrome | |
There was a problem hiding this comment.
| | `launch "app name"` | say "launch chrome" for example, to open chrome | | |
| | `focus <app name>` | say "focus chrome" for example, to switch active window to chrome | | |
| | `running list` | see all active applications | | |
| | `launch <app name>` | say "launch chrome" for example, to open chrome | |
There was a problem hiding this comment.
Why do you want to get rid of documenting the launch command?
There was a problem hiding this comment.
Because GitHub wrongly attributed the suggested change to the wrong lines, even though I tried multiple times. The change was about the < and >
Co-authored-by: Christian Doczkal <20443222+chdoc@users.noreply.github.com>
| | `kebab` | dashes instead of spaces | | ||
| | `help formatters` | show all available formatters | | ||
|
|
||
| `help formatters` shows 2 types of formatters: prose formatters and code formatters. Code formatters are primarily for formatting identifiers and values in computer code. Prose formatters are primarily for ordinary text and are shown with a \* after them. When dictating text with a prose formatter, you can say the following in the middle of dictation. |
There was a problem hiding this comment.
Punctuation :) if you can provide a quick note that it supports lots of post formatting things and we can add a link to a specific description of the prose capture in a different PR.
3 participants
Explain key presses, dictation mode, mouse grid, and reorganize